<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>PeriodFormatter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/goda/time/format/PeriodFormatter.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2005 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time.format;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.util.Locale;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.goda.time.MutablePeriod;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.goda.time.Period;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> org.goda.time.PeriodType;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.goda.time.ReadWritablePeriod;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.goda.time.ReadablePeriod;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">/**</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * Controls the printing and parsing of a time period to and from a string.</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * This class is the main API for printing and parsing used by most applications.</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * Instances of this class are created via one of three factory classes:</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;{@link PeriodFormat} - formats by pattern and style&lt;/li&gt;</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;{@link ISOPeriodFormat} - ISO8601 formats&lt;/li&gt;</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;{@link PeriodFormatterBuilder} - complex formats created via method calls&lt;/li&gt;</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * An instance of this class holds a reference internally to one printer and</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * one parser. It is possible that one of these may be null, in which case the</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * formatter cannot print/parse. This can be checked via the {@link #isPrinter()}</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * and {@link #isParser()} methods.</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * The underlying printer/parser can be altered to behave exactly as required</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * by using a decorator modifier:</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;{@link #withLocale(Locale)} - returns a new formatter that uses the specified locale&lt;/li&gt;</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * This returns a new formatter (instances of this class are immutable).</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * The main methods of the class are the &lt;code&gt;printXxx&lt;/code&gt; and</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;parseXxx&lt;/code&gt; methods. These are used as follows:</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * // print using the default locale</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * String periodStr = formatter.print(period);</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * // print using the French locale</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * String periodStr = formatter.withLocale(Locale.FRENCH).print(period);</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * </em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * // parse using the French locale</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * Period date = formatter.withLocale(Locale.FRENCH).parsePeriod(str);</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> *</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * @author Brian S O'Neill</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> */</em>
<a name="65" href="#65">65</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/goda/time/format/PeriodFormatter.html">PeriodFormatter</a> {
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The internal printer used to output the datetime. */</em>
<a name="68" href="#68">68</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/goda/time/format/PeriodPrinter.html">PeriodPrinter</a> iPrinter;
<a name="69" href="#69">69</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The internal parser used to output the datetime. */</em>
<a name="70" href="#70">70</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/goda/time/format/PeriodParser.html">PeriodParser</a> iParser;
<a name="71" href="#71">71</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The locale to use for printing and parsing. */</em>
<a name="72" href="#72">72</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../java/util/Locale.html">Locale</a> iLocale;
<a name="73" href="#73">73</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The period type used in parsing. */</em>
<a name="74" href="#74">74</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/goda/time/PeriodType.html">PeriodType</a> iParseType;
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <em class="jxr_javadoccomment">/**</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * Creates a new formatter, however you will normally use the factory</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     * or the builder.</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * </em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     * @param printer  the internal printer, null if cannot print</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * @param parser  the internal parser, null if cannot parse</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     */</em>
<a name="83" href="#83">83</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/format/PeriodFormatter.html">PeriodFormatter</a>(
<a name="84" href="#84">84</a>              <a href="../../../../org/goda/time/format/PeriodPrinter.html">PeriodPrinter</a> printer, <a href="../../../../org/goda/time/format/PeriodParser.html">PeriodParser</a> parser) {
<a name="85" href="#85">85</a>          <strong class="jxr_keyword">super</strong>();
<a name="86" href="#86">86</a>          iPrinter = printer;
<a name="87" href="#87">87</a>          iParser = parser;
<a name="88" href="#88">88</a>          iLocale = <strong class="jxr_keyword">null</strong>;
<a name="89" href="#89">89</a>          iParseType = <strong class="jxr_keyword">null</strong>;
<a name="90" href="#90">90</a>      }
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>      <em class="jxr_javadoccomment">/**</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * Constructor.</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * </em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * @param printer  the internal printer, null if cannot print</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     * @param parser  the internal parser, null if cannot parse</em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     * @param locale  the locale to use</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * @param type  the parse period type</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     */</em>
<a name="100" href="#100">100</a>     <strong class="jxr_keyword">private</strong> <a href="../../../../org/goda/time/format/PeriodFormatter.html">PeriodFormatter</a>(
<a name="101" href="#101">101</a>             <a href="../../../../org/goda/time/format/PeriodPrinter.html">PeriodPrinter</a> printer, <a href="../../../../org/goda/time/format/PeriodParser.html">PeriodParser</a> parser,
<a name="102" href="#102">102</a>             <a href="../../../../java/util/Locale.html">Locale</a> locale, <a href="../../../../org/goda/time/PeriodType.html">PeriodType</a> type) {
<a name="103" href="#103">103</a>         <strong class="jxr_keyword">super</strong>();
<a name="104" href="#104">104</a>         iPrinter = printer;
<a name="105" href="#105">105</a>         iParser = parser;
<a name="106" href="#106">106</a>         iLocale = locale;
<a name="107" href="#107">107</a>         iParseType = type;
<a name="108" href="#108">108</a>     }
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="111" href="#111">111</a>     <em class="jxr_javadoccomment">/**</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * Is this formatter capable of printing.</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * </em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * @return true if this is a printer</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     */</em>
<a name="116" href="#116">116</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isPrinter() {
<a name="117" href="#117">117</a>         <strong class="jxr_keyword">return</strong> (iPrinter != <strong class="jxr_keyword">null</strong>);
<a name="118" href="#118">118</a>     }
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a>     <em class="jxr_javadoccomment">/**</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * Gets the internal printer object that performs the real printing work.</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * </em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * @return the internal printer</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     */</em>
<a name="125" href="#125">125</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/format/PeriodPrinter.html">PeriodPrinter</a> getPrinter() {
<a name="126" href="#126">126</a>         <strong class="jxr_keyword">return</strong> iPrinter;
<a name="127" href="#127">127</a>     }
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>     <em class="jxr_javadoccomment">/**</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * Is this formatter capable of parsing.</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * </em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * @return true if this is a parser</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     */</em>
<a name="134" href="#134">134</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isParser() {
<a name="135" href="#135">135</a>         <strong class="jxr_keyword">return</strong> (iParser != <strong class="jxr_keyword">null</strong>);
<a name="136" href="#136">136</a>     }
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     <em class="jxr_javadoccomment">/**</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * Gets the internal parser object that performs the real parsing work.</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * </em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * @return the internal parser</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     */</em>
<a name="143" href="#143">143</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/format/PeriodParser.html">PeriodParser</a> getParser() {
<a name="144" href="#144">144</a>         <strong class="jxr_keyword">return</strong> iParser;
<a name="145" href="#145">145</a>     }
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="148" href="#148">148</a>     <em class="jxr_javadoccomment">/**</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     * Returns a new formatter with a different locale that will be used</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * for printing and parsing.</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * A PeriodFormatter is immutable, so a new instance is returned,</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * and the original is unaltered and still usable.</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * </em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * @param locale  the locale to use</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * @return the new formatter</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">     */</em>
<a name="158" href="#158">158</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/format/PeriodFormatter.html">PeriodFormatter</a> withLocale(<a href="../../../../java/util/Locale.html">Locale</a> locale) {
<a name="159" href="#159">159</a>         <strong class="jxr_keyword">if</strong> (locale == getLocale() || (locale != <strong class="jxr_keyword">null</strong> &amp;&amp; locale.equals(getLocale()))) {
<a name="160" href="#160">160</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a name="161" href="#161">161</a>         }
<a name="162" href="#162">162</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/format/PeriodFormatter.html">PeriodFormatter</a>(iPrinter, iParser, locale, iParseType);
<a name="163" href="#163">163</a>     }
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>     <em class="jxr_javadoccomment">/**</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     * Gets the locale that will be used for printing and parsing.</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * </em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * @return the locale to use</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     */</em>
<a name="170" href="#170">170</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../java/util/Locale.html">Locale</a> getLocale() {
<a name="171" href="#171">171</a>         <strong class="jxr_keyword">return</strong> iLocale;
<a name="172" href="#172">172</a>     }
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="175" href="#175">175</a>     <em class="jxr_javadoccomment">/**</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     * Returns a new formatter with a different PeriodType for parsing.</em>
<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">     * A PeriodFormatter is immutable, so a new instance is returned,</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     * and the original is unaltered and still usable.</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * </em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * @param type  the type to use in parsing</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * @return the new formatter</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     */</em>
<a name="184" href="#184">184</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/format/PeriodFormatter.html">PeriodFormatter</a> withParseType(<a href="../../../../org/goda/time/PeriodType.html">PeriodType</a> type) {
<a name="185" href="#185">185</a>         <strong class="jxr_keyword">if</strong> (type == iParseType) {
<a name="186" href="#186">186</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a name="187" href="#187">187</a>         }
<a name="188" href="#188">188</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/format/PeriodFormatter.html">PeriodFormatter</a>(iPrinter, iParser, iLocale, type);
<a name="189" href="#189">189</a>     }
<a name="190" href="#190">190</a> 
<a name="191" href="#191">191</a>     <em class="jxr_javadoccomment">/**</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">     * Gets the PeriodType that will be used for parsing.</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * </em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * @return the parse type to use</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     */</em>
<a name="196" href="#196">196</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/PeriodType.html">PeriodType</a> getParseType() {
<a name="197" href="#197">197</a>         <strong class="jxr_keyword">return</strong> iParseType;
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="201" href="#201">201</a>     <em class="jxr_javadoccomment">/**</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * Prints a ReadablePeriod to a StringBuffer.</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     *</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * @param buf  the formatted period is appended to this buffer</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * @param period  the period to format, not null</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     */</em>
<a name="207" href="#207">207</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> printTo(StringBuffer buf, <a href="../../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> period) {
<a name="208" href="#208">208</a>         checkPrinter();
<a name="209" href="#209">209</a>         checkPeriod(period);
<a name="210" href="#210">210</a>         
<a name="211" href="#211">211</a>         getPrinter().printTo(buf, period, iLocale);
<a name="212" href="#212">212</a>     }
<a name="213" href="#213">213</a> 
<a name="214" href="#214">214</a>     <em class="jxr_javadoccomment">/**</em>
<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">     * Prints a ReadablePeriod to a Writer.</em>
<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">     *</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * @param out  the formatted period is written out</em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     * @param period  the period to format, not null</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     */</em>
<a name="220" href="#220">220</a> <em class="jxr_comment">//    public void printTo(Writer out, ReadablePeriod period) throws IOException {</em>
<a name="221" href="#221">221</a> <em class="jxr_comment">//        checkPrinter();</em>
<a name="222" href="#222">222</a> <em class="jxr_comment">//        checkPeriod(period);</em>
<a name="223" href="#223">223</a> <em class="jxr_comment">//        </em>
<a name="224" href="#224">224</a> <em class="jxr_comment">//        getPrinter().printTo(out, period, iLocale);</em>
<a name="225" href="#225">225</a> <em class="jxr_comment">//    }</em>
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>     <em class="jxr_javadoccomment">/**</em>
<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * Prints a ReadablePeriod to a new String.</em>
<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     *</em>
<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     * @param period  the period to format, not null</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * @return the printed result</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     */</em>
<a name="233" href="#233">233</a>     <strong class="jxr_keyword">public</strong> String print(<a href="../../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> period) {
<a name="234" href="#234">234</a>         checkPrinter();
<a name="235" href="#235">235</a>         checkPeriod(period);
<a name="236" href="#236">236</a>         
<a name="237" href="#237">237</a>         <a href="../../../../org/goda/time/format/PeriodPrinter.html">PeriodPrinter</a> printer = getPrinter();
<a name="238" href="#238">238</a>         StringBuffer buf = <strong class="jxr_keyword">new</strong> StringBuffer(printer.calculatePrintedLength(period, iLocale));
<a name="239" href="#239">239</a>         printer.printTo(buf, period, iLocale);
<a name="240" href="#240">240</a>         <strong class="jxr_keyword">return</strong> buf.toString();
<a name="241" href="#241">241</a>     }
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a>     <em class="jxr_javadoccomment">/**</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * Checks whether printing is supported.</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * </em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * @throws UnsupportedOperationException if printing is not supported</em>
<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     */</em>
<a name="248" href="#248">248</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkPrinter() {
<a name="249" href="#249">249</a>         <strong class="jxr_keyword">if</strong> (iPrinter == <strong class="jxr_keyword">null</strong>) {
<a name="250" href="#250">250</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException(<span class="jxr_string">"Printing not supported"</span>);
<a name="251" href="#251">251</a>         }
<a name="252" href="#252">252</a>     }
<a name="253" href="#253">253</a> 
<a name="254" href="#254">254</a>     <em class="jxr_javadoccomment">/**</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     * Checks whether the period is non-null.</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     * </em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if the period is null</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment">     */</em>
<a name="259" href="#259">259</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkPeriod(<a href="../../../../org/goda/time/ReadablePeriod.html">ReadablePeriod</a> period) {
<a name="260" href="#260">260</a>         <strong class="jxr_keyword">if</strong> (period == <strong class="jxr_keyword">null</strong>) {
<a name="261" href="#261">261</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Period must not be null"</span>);
<a name="262" href="#262">262</a>         }
<a name="263" href="#263">263</a>     }
<a name="264" href="#264">264</a> 
<a name="265" href="#265">265</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="266" href="#266">266</a>     <em class="jxr_javadoccomment">/**</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * Parses a period from the given text, at the given position, saving the</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     * result into the fields of the given ReadWritablePeriod. If the parse</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">     * succeeds, the return value is the new text position. Note that the parse</em>
<a name="270" href="#270">270</a> <em class="jxr_javadoccomment">     * may succeed without fully reading the text.</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     * The parse type of the formatter is not used by this method.</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * If it fails, the return value is negative, but the period may still be</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * modified. To determine the position where the parse failed, apply the</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * one's complement operator (~) on the return value.</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     *</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * @param period  a period that will be modified</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     * @param text  text to parse</em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * @param position position to start parsing from</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment">     * @return new position, if negative, parse failed. Apply complement</em>
<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">     * operator (~) to get position of failure</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if any field is out of range</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     */</em>
<a name="285" href="#285">285</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> parseInto(<a href="../../../../org/goda/time/ReadWritablePeriod.html">ReadWritablePeriod</a> period, String text, <strong class="jxr_keyword">int</strong> position) {
<a name="286" href="#286">286</a>         checkParser();
<a name="287" href="#287">287</a>         checkPeriod(period);
<a name="288" href="#288">288</a>         
<a name="289" href="#289">289</a>         <strong class="jxr_keyword">return</strong> getParser().parseInto(period, text, position, iLocale);
<a name="290" href="#290">290</a>     }
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>     <em class="jxr_javadoccomment">/**</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">     * Parses a period from the given text, returning a new Period.</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">     *</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment">     * @param text  text to parse</em>
<a name="296" href="#296">296</a> <em class="jxr_javadoccomment">     * @return parsed value in a Period object</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if any field is out of range</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">     */</em>
<a name="299" href="#299">299</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/Period.html">Period</a> parsePeriod(String text) {
<a name="300" href="#300">300</a>         checkParser();
<a name="301" href="#301">301</a>         
<a name="302" href="#302">302</a>         <strong class="jxr_keyword">return</strong> parseMutablePeriod(text).toPeriod();
<a name="303" href="#303">303</a>     }
<a name="304" href="#304">304</a> 
<a name="305" href="#305">305</a>     <em class="jxr_javadoccomment">/**</em>
<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">     * Parses a period from the given text, returning a new MutablePeriod.</em>
<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">     *</em>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">     * @param text  text to parse</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">     * @return parsed value in a MutablePeriod object</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if any field is out of range</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     */</em>
<a name="312" href="#312">312</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../org/goda/time/MutablePeriod.html">MutablePeriod</a> parseMutablePeriod(String text) {
<a name="313" href="#313">313</a>         checkParser();
<a name="314" href="#314">314</a>         
<a name="315" href="#315">315</a>         <a href="../../../../org/goda/time/MutablePeriod.html">MutablePeriod</a> period = <strong class="jxr_keyword">new</strong> <a href="../../../../org/goda/time/MutablePeriod.html">MutablePeriod</a>(0, iParseType);
<a name="316" href="#316">316</a>         <strong class="jxr_keyword">int</strong> newPos = getParser().parseInto(period, text, 0, iLocale);
<a name="317" href="#317">317</a>         <strong class="jxr_keyword">if</strong> (newPos &gt;= 0) {
<a name="318" href="#318">318</a>             <strong class="jxr_keyword">if</strong> (newPos &gt;= text.length()) {
<a name="319" href="#319">319</a>                 <strong class="jxr_keyword">return</strong> period;
<a name="320" href="#320">320</a>             }
<a name="321" href="#321">321</a>         } <strong class="jxr_keyword">else</strong> {
<a name="322" href="#322">322</a>             newPos = ~newPos;
<a name="323" href="#323">323</a>         }
<a name="324" href="#324">324</a>         <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(FormatUtils.createErrorMessage(text, newPos));
<a name="325" href="#325">325</a>     }
<a name="326" href="#326">326</a> 
<a name="327" href="#327">327</a>     <em class="jxr_javadoccomment">/**</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     * Checks whether parsing is supported.</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment">     * </em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment">     * @throws UnsupportedOperationException if parsing is not supported</em>
<a name="331" href="#331">331</a> <em class="jxr_javadoccomment">     */</em>
<a name="332" href="#332">332</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkParser() {
<a name="333" href="#333">333</a>         <strong class="jxr_keyword">if</strong> (iParser == <strong class="jxr_keyword">null</strong>) {
<a name="334" href="#334">334</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException(<span class="jxr_string">"Parsing not supported"</span>);
<a name="335" href="#335">335</a>         }
<a name="336" href="#336">336</a>     }
<a name="337" href="#337">337</a> 
<a name="338" href="#338">338</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

